/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements.  See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership.  The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License.  You may obtain a copy of the License at
*
*   http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied.  See the License for the
* specific language governing permissions and limitations
* under the License.    
*/

/* Generated By:JavaCC: Do not edit this line. ParseException.java Version 2.1 */

namespace NVelocity.Runtime.Parser
{
    using System;

    /// <summary> This exception is thrown when parse errors are encountered.
    /// It is intended to be caught and typically will be rethrown
    /// as a ParseErrorException.
    /// 
    /// <p>You can explicitly create objects of this exception type by
    /// calling the method generateParseException in the generated
    /// parser.
    /// 
    /// You can modify this class to customize your error reporting
    /// mechanisms so long as you retain the public fields.
    /// </summary>
    [Serializable]
    public class ParseException : Exception
    {
        /// <summary> This method has the standard behavior when this object has been
        /// created using the standard constructors.  Otherwise, it uses
        /// "currentToken" and "expectedTokenSequences" to generate a parse
        /// error message and returns it.  If this object has been created
        /// due to a parse error, and you do not catch it (it gets thrown
        /// from the parser), then this method is called during the printing
        /// of the final stack trace, and hence the correct error message
        /// gets displayed.
        /// </summary>
        public override System.String Message
        {
            get
            {
                if (!specialConstructor)
                {
                    return base.Message;
                }
                System.String expected = "";
                int maxSize = 0;
                for (int i = 0; i < expectedTokenSequences.Length; i++)
                {
                    if (maxSize < expectedTokenSequences[i].Length)
                    {
                        maxSize = expectedTokenSequences[i].Length;
                    }
                    for (int j = 0; j < expectedTokenSequences[i].Length; j++)
                    {
                        expected += (tokenImage[expectedTokenSequences[i][j]] + " ");
                    }
                    if (expectedTokenSequences[i][expectedTokenSequences[i].Length - 1] != 0)
                    {
                        expected += "...";
                    }
                    expected += (eol + "    ");
                }
                System.String retval = "Encountered \"";
                Token tok = currentToken.Next;
                for (int i = 0; i < maxSize; i++)
                {
                    if (i != 0)
                        retval += " ";
                    if (tok.Kind == 0)
                    {
                        retval += tokenImage[0];
                        break;
                    }
                    retval += AddEscapes(tok.Image);
                    tok = tok.Next;
                }
                retval += ("\" at line " + currentToken.Next.BeginLine + ", column " + currentToken.Next.BeginColumn);
                retval += ("." + eol);
                if (expectedTokenSequences.Length == 1)
                {
                    retval += ("Was expecting:" + eol + "    ");
                }
                else
                {
                    retval += ("Was expecting one of:" + eol + "    ");
                }
                retval += expected;
                return retval;
            }

        }

        /// <summary> This constructor is used by the method "generateParseException"
        /// in the generated parser.  Calling this constructor generates
        /// a new object of this type with the fields "currentToken",
        /// "expectedTokenSequences", and "tokenImage" set.  The boolean
        /// flag "specialConstructor" is also set to true to indicate that
        /// this constructor was used to create this object.
        /// This constructor calls its super class with the empty string
        /// to force the "toString" method of parent class "Throwable" to
        /// print the error message in the form:
        /// ParseException: <result of getMessage>
        /// </summary>
        public ParseException(Token currentTokenVal, int[][] expectedTokenSequencesVal, System.String[] tokenImageVal)
            : base("")
        {
            specialConstructor = true;
            currentToken = currentTokenVal;
            expectedTokenSequences = expectedTokenSequencesVal;
            tokenImage = tokenImageVal;
        }

        /// <summary> The following constructors are for use by you for whatever
        /// purpose you can think of.  Constructing the exception in this
        /// manner makes the exception behave in the normal way - i.e., as
        /// documented in the class "Throwable".  The fields "errorToken",
        /// "expectedTokenSequences", and "tokenImage" do not contain
        /// relevant information.  The JavaCC generated code does not use
        /// these constructors.
        /// </summary>

        public ParseException()
            : base()
        {
            specialConstructor = false;
        }

        public ParseException(System.String message)
            : base(message)
        {
            specialConstructor = false;
        }

        /// <summary> This variable determines which constructor was used to create
        /// this object and thereby affects the semantics of the
        /// "getMessage" method (see below).
        /// </summary>
        protected internal bool specialConstructor;

        /// <summary> This is the last token that has been consumed successfully.  If
        /// this object has been created due to a parse error, the token
        /// followng this token will (therefore) be the first error token.
        /// </summary>
        public Token currentToken;

        /// <summary> Each entry in this array is an array of integers.  Each array
        /// of integers represents a sequence of tokens (by their ordinal
        /// values) that is expected at this point of the parse.
        /// </summary>
        public int[][] expectedTokenSequences;

        /// <summary> This is a reference to the "tokenImage" array of the generated
        /// parser within which the parse error occurred.  This array is
        /// defined in the generated ...Constants interface.
        /// </summary>
        public System.String[] tokenImage;

        /// <summary> The end of line string for this machine.</summary>
        protected internal System.String eol = Environment.NewLine;

        /// <summary> Used to convert raw characters to their escaped version
        /// when these raw version cannot be used as part of an ASCII
        /// string literal.
        /// </summary>
        protected internal virtual System.String AddEscapes(System.String str)
        {
            System.Text.StringBuilder retval = new System.Text.StringBuilder();
            char ch;
            for (int i = 0; i < str.Length; i++)
            {
                switch (str[i])
                {

                    case (char)(0):
                        continue;

                    case '\b':
                        retval.Append("\\b");
                        continue;

                    case '\t':
                        retval.Append("\\t");
                        continue;

                    case '\n':
                        retval.Append("\\n");
                        continue;

                    case '\f':
                        retval.Append("\\f");
                        continue;

                    case '\r':
                        retval.Append("\\r");
                        continue;

                    case '\"':
                        retval.Append("\\\"");
                        continue;

                    case '\'':
                        retval.Append("\\\'");
                        continue;

                    case '\\':
                        retval.Append("\\\\");
                        continue;

                    default:
                        if ((ch = str[i]) < 0x20 || ch > 0x7e)
                        {
                            System.String s = "0000" + System.Convert.ToString(ch, 16);
                            retval.Append("\\u" + s.Substring(s.Length - 4, (s.Length) - (s.Length - 4)));
                        }
                        else
                        {
                            retval.Append(ch);
                        }
                        continue;

                }
            }
            return retval.ToString();
        }
    }
}